Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

🎉 Source Google Ads: Better error message handling in check connection #11371

Merged
merged 5 commits into from
Mar 25, 2022
Merged

🎉 Source Google Ads: Better error message handling in check connection #11371

merged 5 commits into from
Mar 25, 2022

Conversation

edgao
Copy link
Contributor

@edgao edgao commented Mar 23, 2022 •
edited
Loading

What

Previously, if check_connection received an error response from Google's API, we would just stringify the response and dump it into the UI (#10786 (comment)). Now we are extracting the error message so it's formatted nicely:
Screen Shot 2022-03-23 at 1 12 04 PM

Also, we were throwing exceptions rather than returning a (booleanSuccess, stringMessage) tuple in some cases; fix that. This manifested as a slightly ugly error message.

How

We receive back one (or more) error structs. Extract the message from them.

We ignore the other fields, which could hide useful information? But I tested a couple different incorrect configs and they all had reasonable error messages. Also, the full exception is logged, so it's still available if needed.

🚨 User Impact 🚨

none

Pre-merge Checklist

Expand the relevant checklist and delete the others.

Community member or Airbyter

  • Grant edit access to maintainers (instructions)
  • Secrets in the connector's spec are annotated with airbyte_secret
  • Unit & integration tests added and passing. Community members, please provide proof of success locally e.g: screenshot or copy-paste unit, integration, and acceptance test output. To run acceptance tests for a Python connector, follow instructions in the README. For java connectors run ./gradlew :airbyte-integrations:connectors:<name>:integrationTest.
  • Code reviews completed
  • Documentation updated
    • Connector's README.md
    • Connector's bootstrap.md. See description and examples
    • Changelog updated in docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
  • PR name follows PR naming conventions

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

  • Create a non-forked branch based on this PR and test the below items on it
  • Build is successful
  • If new credentials are required for use in CI, add them to GSM. Instructions.
  • /test connector=connectors/<name> command is passing
  • New Connector version released on Dockerhub by running the /publish command described here
  • After the new connector version is published, connector version bumped in the seed directory as described here
  • Seed specs have been re-generated by building the platform and committing the changes to the seed spec files, as described here

@github-actions github-actions bot added the area/connectors Connector related issues label Mar 23, 2022
@edgao
Copy link
Contributor Author

edgao commented Mar 23, 2022 •
edited by github-actions bot
Loading

/test connector=connectors/source-google-ads

🕑 connectors/source-google-ads https://github.com/airbytehq/airbyte/actions/runs/2030590418
✅ connectors/source-google-ads https://github.com/airbytehq/airbyte/actions/runs/2030590418
Python tests coverage:

Name                                                 Stmts   Miss  Cover
------------------------------------------------------------------------
source_acceptance_test/utils/__init__.py                 6      0   100%
source_acceptance_test/tests/__init__.py                 4      0   100%
source_acceptance_test/__init__.py                       2      0   100%
source_acceptance_test/tests/test_full_refresh.py       52      2    96%
source_acceptance_test/utils/asserts.py                 37      2    95%
source_acceptance_test/config.py                        74      6    92%
source_acceptance_test/utils/json_schema_helper.py     105     13    88%
source_acceptance_test/utils/common.py                  70     17    76%
source_acceptance_test/utils/compare.py                 62     23    63%
source_acceptance_test/tests/test_core.py              275    106    61%
source_acceptance_test/base.py                          10      4    60%
source_acceptance_test/utils/connector_runner.py       110     48    56%
source_acceptance_test/tests/test_incremental.py        69     38    45%
------------------------------------------------------------------------
TOTAL                                                  876    259    70%
Name                                       Stmts   Miss  Cover
--------------------------------------------------------------
source_google_ads/__init__.py                  2      0   100%
source_google_ads/google_ads.py               68     10    85%
source_google_ads/streams.py                 130     24    82%
source_google_ads/source.py                   76     26    66%
source_google_ads/custom_query_stream.py      75     50    33%
--------------------------------------------------------------
TOTAL                                        351    110    69%
Name                                       Stmts   Miss  Cover
--------------------------------------------------------------
source_google_ads/__init__.py                  2      0   100%
source_google_ads/custom_query_stream.py      75      6    92%
source_google_ads/streams.py                 130     11    92%
source_google_ads/google_ads.py               68      7    90%
source_google_ads/source.py                   76     21    72%
--------------------------------------------------------------
TOTAL                                        351     45    87%

Python short test summary info:

=========================== short test summary info ============================
SKIPPED [1] ../usr/local/lib/python3.7/site-packages/source_acceptance_test/plugin.py:56: Skipping TestIncremental.test_two_sequential_reads because not found in the config
================== 21 passed, 1 skipped in 1458.97s (0:24:18) ==================

@edgao edgao marked this pull request as ready for review March 23, 2022 23:39
@edgao edgao requested a review from sherifnada March 23, 2022 23:39
@edgao
Copy link
Contributor Author

edgao commented Mar 24, 2022

/publish connector=connectors/source-google-ads

@github-actions github-actions bot added the area/documentation Improvements or additions to documentation label Mar 24, 2022
@edgao
Copy link
Contributor Author

edgao commented Mar 24, 2022

/publish connector=connectors/source-google-ads

@edgao
Copy link
Contributor Author

edgao commented Mar 24, 2022 •
edited by github-actions bot
Loading

/publish connector=connectors/source-google-ads

🕑 connectors/source-google-ads https://github.com/airbytehq/airbyte/actions/runs/2036584171
✅ connectors/source-google-ads https://github.com/airbytehq/airbyte/actions/runs/2036584171

@edgao edgao temporarily deployed to more-secrets March 24, 2022 22:40 Inactive
@edgao edgao temporarily deployed to more-secrets March 24, 2022 22:40 Inactive
@edgao edgao merged commit a845919 into master Mar 25, 2022
@edgao edgao deleted the edgao/source_gads_check_connection_error_output branch March 25, 2022 01:47
@octavia-squidington-iii octavia-squidington-iii mentioned this pull request Mar 28, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sherifnada sherifnada sherifnada approved these changes

Assignees
No one assigned
Labels
area/connectors Connector related issues area/documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@edgao @sherifnada